home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / faxdor17.zip / FAXDOR17.DOC < prev    next >
Text File  |  1992-10-18  |  19KB  |  416 lines
  1.  
  2.  
  3.  
  4. ═════════════════════════════════════════════════════════════════════════════=
  5.  
  6.                           Fax-Door Release 1.07
  7.  
  8.                     Fax ASCII Text file on the spot!
  9.  
  10.                    Door Registration is only $10.00!
  11.  
  12.               Written by: Gerry Freymann
  13.                           P.O. Box 1226
  14.                           Cobourg, Ontario
  15.                           K9A 5A4
  16.  
  17.           The Phantom BBS (416) 342-3734 USR HST Dual Standard
  18.                           (416) 342-3766 19200 USR HST
  19.  
  20. ═════════════════════════════════════════════════════════════════════════════=
  21.  
  22.  
  23.  
  24.  
  25.  
  26. Brief Update History
  27. ─────────────────────────────────────────────────────────────────────────
  28. Please view the file CHANGES.DOC for a complete history.
  29.  
  30.  
  31. Overview of Fax-Door
  32. ──────────────────────────────────────────────────────────────────────────
  33. Fax-Door was written to provide users of my BBS the chance to Fax
  34. ASCII Text files to other fax machines in the area.  I originally bought
  35. the Fax Card for my personal benefit, and once I saw how simple it was to
  36. use the BitFax software, I figured it would be a fairly simple job to
  37. create a door to take advantage of the Fax card and BitFax software.
  38.  
  39. A simple door?  Well, that's a matter of opinion I'm sure, but this is
  40. far from being "just a simple door" as you will soon see.
  41.  
  42. My Fax-Door will display information to NewUsers, create a personal ten
  43. number dialing directory, offer a variety of transfer protocols, place
  44. comments in your caller log, as well as a separate door log file, allow
  45. long distance faxing for pre-approved users (you define the number
  46. of credits or available pages), fax on-the-spot, report the fax status,
  47. update user accounts, delete all temporary files....
  48.  
  49. I have the door set up to allow FREE local faxing.  What the hay?  It's
  50. a great service that is fairly cheap to add to your system so why bother
  51. the users and have them pay per fax?
  52.  
  53. All in all, I think you'll be quite pleased.
  54.  
  55.  
  56. Fax-Door Requirements
  57. ──────────────────────────────────────────────────────────────────────────
  58. First of all, Fax-Door may not be for everybody.  There are a few
  59. requirements you should be aware of, that may make this door unsuitable for
  60. some Bulletin Board Systems:
  61.  
  62. - You'll need room in your computer for an internal Fax-Card.  That not only
  63.   means phsyical space, but also free interupts and com ports.
  64.  
  65. - You need an extra phone line, in ADDITION to the BBS Line, as the door
  66.   faxes with the caller online.
  67.  
  68. - You need a Fax board that uses the BitFax software (C) 1989 BIT Software,
  69.   Inc.  All Rights Reserved.  I have used BitFax v.2.061 and 2.062
  70.   successfully.  Version 3.0 has also been reported to work fine.
  71.  
  72. - This only works on the node where the Fax card is inserted.  On a multi
  73.   node system, this means the fax service will only be available on one of
  74.   your nodes.
  75.  
  76. - You must have a copy of DSZ in your Path
  77.  
  78. - You'll need lots of free RAM!  The door exits to DOS and runs a BATCH
  79.   file to run BitFax but shells out to DSZ to accept the uploaded file to fax.  Bulletin
  80.   Boards operating under DoubleDos or Desqview must be sure they have
  81.   enough RAM leftover for proper door operation.
  82.  
  83. - The door assumes a local call is 7 or 5 digits in length (minus brackets &
  84.   dashes).  If you are in a location where a local call is more, than you'll
  85.   need a customized version.  Please contact me and provide details and we
  86.   can get you set up.  Example local call:  3724915 or 24915
  87.  
  88. - The door also assumes that a long distance call is 8 or 11 digits in length
  89.   (minus brackets and dashes).  Again, if this a problem in your location
  90.   please contact me and we can get you set up with a customized version.
  91.   Example long distance call:  14163724915 or 13724915
  92.  
  93. - The door will ignore any phone number 4 digits or less, 6, 9 or 10 digits
  94.   or 12 and great and report these as invalid numbers.  If this is a problem
  95.   for you please contact me.
  96.  
  97. - Only 999 users may use the door with all of its bells and whistles.  The
  98.   1000th user and above will have access, but will not have a personal
  99.   dialing directory and therefore have no access to the Long Distance
  100.   option.
  101.  
  102. With all that said, if you still feel this door is for you, then by all
  103. means read on!
  104.  
  105.  
  106. Command-line parameters
  107. ──────────────────────────────────────────────────────────────────────────
  108. Once you've configured DoorPatch 3.8 you run Faxdoor in local mode by
  109. using the /LOCAL command-line switch as follows:
  110.  
  111.         FAXDOOR FAXDOOR.CFG /LOCAL   <== Allows local usage of the DOOR as
  112.                                          the SysOp.
  113.  
  114.  
  115. Files needed for Fax-Door Operation
  116. ──────────────────────────────────────────────────────────────────────────
  117. If you have any doubt about the integrity of the files contained in this
  118. ARCHive, feel free to call my BBS in Baltimore, Ontario Canada and download
  119. the latest version.
  120.  
  121.  
  122. DOOR     BAT * | Used when returning from a Fax, explained later
  123. FAXDOOR  CFG * | Your Configuration file, explained later
  124. FAXDOOR  EXE   | The main Fax-Door executible
  125. FAXEDIT  EXE   | User File Editor, explained later
  126. FAXDOOR  PGE * | OPTIONAL, explained later.
  127. FAXDOOR  REG   | Provided when you Register your copy, explained later
  128. FAXDOOR  PRE * | OPTIONAL list of local prefixes, explained later
  129. FAXHELP  TXT   | Help file for user while in door
  130. FAXING   TXT * | Displayed just as the door exits and goes to send the fax
  131. FAXME    BLT   | Your menu of files that the user can have faxed to them
  132. FAXME    ###   | ### = 1 to 999 - Your actual FaxBack files
  133. HELLO2   TXT * | Displayed when a user returns from sending a fax
  134. MENU     TXT * | The Main Menu
  135. MINUS    TXT * | Displayed when attempting to fax LD with a deficit balance
  136. NEWUSER  TXT * | Displayed once, to every new user of the Door
  137. PLUS     TXT * | Displayed before a Long Distance fax if credits remain
  138. XM1KG    BAT * | Xmodem-G transfer batch file (set to use Com1)
  139. XMD1K    BAT * | Xmodem-1K transfer batch file (set to use Com1)
  140. XMDCRC   BAT * | Xmodem-CRC transfer batch file (set to use Com1)
  141. YMD      BAT * | Ymodem transfer batch file (set to use Com1)
  142. YMD1KG   BAT * | Ymodem-1KG transfer batch file (set to use Com1)
  143. ZERO     TXT * | Displayed when attempting to fax LD with no credits left
  144. ZMD      BAT * | Zmodem transfer batch file (set to use Com1)
  145. FAX          * | Sample Batch file to activate the Door, explained later
  146. FAXDOR16 DOC   | This documentation
  147. CHANGES  DOC   | History file listing changes in each version
  148. FAXDV    DOC * | Jon's brain storm on a DV Receive Fax window!
  149. FLYER    DOC   | List of other programs available from me
  150. LICENSE  DOC   | Please read, understand and agree with
  151. SYSOP    DOC   | DoorPatch 3.8 setup instructions
  152. REGISTER FRM   | Print out, complete and mail with register fee
  153. QUICKGO  DOC   | Quick, no muss, no fuss installation & set up
  154. ECHOFAX  DOC   | Information on a message base fax utility now available!
  155.  
  156. Files created by the door
  157.  
  158. FAX      BAT   | Temporary batch file, explained later
  159. DOFAX    YES   | Temporary batch file, explained later
  160. FAXDOR## LOG   | Log file in the door subdirectory of user actions
  161. FAXDOOR  ###   | User Data files, 001-999, explained later
  162. FAXDOOR  DTA   | Master list of User names and their Data File Name
  163.  
  164. Files marked with an asterisk (*) mean you should go over and edit these
  165. files as you see fit.  Be sure to check the transfer batch files so they
  166. are set for the correct com port that the door will be using.
  167.  
  168. All of the above files should be in the same subdirectory as your BitFax
  169. program.  Explainations of their purposes follow.
  170.  
  171.  
  172. DOOR.BAT --> Keep in your Door/BitFax Subdirectory
  173. ──────────────────────────────────────────────────────────────────────────
  174. ECHO OFF
  175. FAXDOOR FAXDOOR.CFG
  176. IF EXIST DOFAX.YES FAX
  177. C:
  178. CD\PCB
  179. BOARD
  180.  
  181. You will need to edit this file, if your PCB subdirectory is not located
  182. on Drive C: subdirectory \PCB.  This file is called by the door after
  183. sending a fax and is used to allow the Fax-Door to recycle.
  184. YOU MUST HAVE THIS FILE IN THE DOOR/BITFAX SUBDIRECTORY AND IT MUST HAVE
  185. CORRECT DRIVE LETTERS AND PATHS.
  186.  
  187.  
  188. FAXDOOR.CFG --> Keep in your Door/BitFax Subdirectory
  189. ──────────────────────────────────────────────────────────────────────────
  190. C:\PCB\PCBOARD.SYS   | Location of your PCBoard.Sys file
  191. The Phantom BBS      | Your BBS Name
  192. Gerry                | Sysop First Name
  193. Freymann             | Sysop Last Name
  194. Donor Name           | The donor of the DOOR
  195.  
  196. It's the standard DoorPatch configuration file, so if you have a "generic"
  197. configuration file for DoorPatch doors, you can use that one.
  198.  
  199.  
  200. FAXDOOR.PGE --> Place in your Door/BitFax Subdirectory
  201. ──────────────────────────────────────────────────────────────────────────
  202. This OPTIONAL file allows you to customize the appearance of your Fax
  203. service.  This file can be up to 51 lines long and will be combined with
  204. the existing covering letter.
  205.  
  206.  
  207. FAXDOOR.REG --> Place in your Door/BitFax Subdirectory
  208. ──────────────────────────────────────────────────────────────────────────
  209. Our new registration process will create this file for you.  When you
  210. register, you are given a small utility program that you run from within
  211. the door subdirectory.  Once you have a valid REG file, the door which
  212. you are already running will magically say Registered to you.
  213.  
  214.  
  215. FAXEDIT.EXE --> Place in your Door/BitFax Subdirectory
  216. ──────────────────────────────────────────────────────────────────────────
  217. This is a very nice user file editor for use with the door.  An easy way
  218. to add credits to a user account, or edit somebody's dialing directory,
  219. or just plain be nosy!  One catch.... this only works when you Register
  220. your copy of the Door.  To load the door, pass on the name of one of your
  221. Faxdoor configuration files.  For example:  FAXEDIT FAXDOOR.CFG
  222.  
  223.  
  224. FAXDOOR.PRE --> Place in your Door/BitFax Subdirectory
  225. ──────────────────────────────────────────────────────────────────────────
  226. 342
  227. 349
  228. 352
  229. 372
  230. 373
  231. 797
  232. 885
  233.  
  234. This file gives you the chance to ensure that when a user enters a "local"
  235. number, it is indeed a valid local number.  Simply place all valid local
  236. dialing prefixes, one per line in this file.  THIS FILE IS OPTIONAL!  If
  237. you do not create a FaxDoor.Pre file, no validity checks will take place.
  238. As you can see, I don't have a whole heck of a lot of local exchanges, so
  239. it was a piece of cake for me, but in Metropolitan areas, you might spend
  240. a day typing in all the exchanges and might be better off to leave it out!
  241.  
  242.  
  243. *.TXT --> Place in your Door/BitFax Subdirectory
  244. ──────────────────────────────────────────────────────────────────────────
  245. These text files are displayed to the user at various points throughout
  246. the door.  You will need to edit some of them, depending on how you wish
  247. to run the door.  I grant free local faxing and the text files provided
  248. display that to the users.  I charge for Long Distance faxing, on a prepaid,
  249. preapproved basis and the text files display that.  You may change and/or
  250. edit any or all of these files as you see fit.
  251.  
  252.  
  253. *.BAT --> Place in your Door/BitFax Subdirectory
  254. ──────────────────────────────────────────────────────────────────────────
  255. These are all of your Upload Protocol transfer batch files.  You should
  256. edit these if you aren't using Com1 to run the Fax-Door.
  257.  
  258.  
  259. FAX  --> Place in your \PCB Subdirectory
  260. FAX.BAT --> Created and maintained by the Door
  261. DOFAX.YES --> Created and maintained by the Door
  262. ──────────────────────────────────────────────────────────────────────────
  263. ECHO OFF                       | Turn Echo OFF
  264. T:                             | Log to Drive T:
  265. CD\BITFAX                      | Change Directory to the BitFax/Door area
  266. FAXDOOR FAXDOOR.CFG            | Load the door and using the .cfg file
  267. IF EXIST DOFAX.YES FAX         | Key file maintained by the door
  268. C:                             | Log back to starting drive
  269. CD\PCB                         | Change back to main \PCB area
  270. BOARD                          | Reload the BBS
  271.  
  272. This is my door batch file that calls up the FaxDoor.  Using the name "FAX"
  273. a user can simply type FAX at the PCBoard 14.5 prompt and be taken into
  274. the Fax door.  The If Exist line is the key to calling up the BitFax
  275. software.  The door will automatically create a FAX.BAT file which will
  276. instruct BitFax on what file to send and what number to dial.  The end of
  277. FAX.BAT calls DOOR.BAT (Door.Bat is provided and was discussed earlier)
  278. and allows the Fax-Door to reload and gather stats etc.  The file DOFAX.YES
  279. is also created by the door and holds some data which the door reads after
  280. sending the fax to complete the statistic gathering.  Both of these files
  281. are deleted automatically by the door.
  282.  
  283.  
  284. FAXDOOR.###  --> Created and maintained by the Door
  285. ──────────────────────────────────────────────────────────────────────────
  286. "PHANTOM BBS","342-3766"
  287. "**","**"
  288. "**","**"
  289. "**","**"
  290. "**","**"
  291. "**","**"
  292. "**","**"
  293. "**","**"
  294. "**","**"
  295. "**","**"
  296. " 0","N"
  297.  
  298. These files are the User Files created by the door.  They are numbered
  299. 001 to 999.  The format is very simple.  It's an ASCII file with two
  300. fields per line, separated by a comma with each field surrounded by
  301. quotation marks.  The first field is a description of the number and
  302. the second field is the actual fax number.  There are ten lines providing
  303. each user with their very own personal ten number dialing directory.  A
  304. user may enter a number manually or dial a number contained in their
  305. directory.
  306.  
  307. The last line is rather unique.  The first field of the eleventh line
  308. will start at zero.  If you wish to grant Long Distance faxing to a user
  309. you need to read FAXDOOR.DTA to get their filename, then edit this line
  310. in their file and insert the number of "credits" or pages you wish them
  311. to have.  Try to remember to leave a leading space before the number?
  312. The door will only allow a person to fax to a long distance number if they
  313. have a postive value.  If they have 0 or a negative number, no long distance
  314. faxing will be allowed (local faxes remain available).  The door will
  315. maintain the number of credits for you and displays certain TXT files
  316. after a successful fax based on the value in this field.
  317.  
  318. The second field is not in use at this time and has been left in for
  319. future uses.  Both fields, as with the rest of the datafile, should be
  320. surrounded by quotes and separated by a comma.
  321.  
  322. If you register your copy of Fax-Door the FAXEDIT program will magically
  323. start to work and you won't really have to bother with all this stuff.
  324.  
  325. Only 999 users may use the door with all of its bells and whistles.  The
  326. 1000th user and above will have access, but will not have a personal
  327. dialing directory and therefore have no access to the Long Distance
  328. option.
  329.  
  330.  
  331. FAXDOOR.DTA  --> Created and maintained by the Door
  332. ──────────────────────────────────────────────────────────────────────────
  333. "USER ONE","FAXDOOR.001"
  334. "USER TWO","FAXDOOR.002"
  335. "USER THREE","FAXDOOR.003"
  336. "USER FOUR","FAXDOOR.004"
  337.  
  338. This is only a sample of the Data file created by the door.  It is a simple
  339. ASCII file with two fields per line, surrounded by quotation marks and
  340. separated by a comma.  The first field is the User Name and the second
  341. field is the name of their personal data file (explained above).  You are
  342. limited to 1000 users!
  343.  
  344.  
  345. FAXDOR## LOG  --> Created and maintained by the Door
  346. ──────────────────────────────────────────────────────────────────────────
  347. **************************************************************
  348. GERRY FREYMANN entered FAX-DOOR 02-13-1991 22:58:28
  349. Uploaded TEST.FAX using Zmodem
  350. Dial (A)borted!
  351. **************************************************************
  352. GERRY FREYMANN entered FAX-DOOR 02-13-1991 23:50:38
  353. Uploaded TEST.FAX using Zmodem
  354. Faxing TEST.FAX to 3425544
  355. CFMX.FAX      1     00:25    OK
  356. Uploaded TEST.DOC using Zmodem
  357. File transfer was UNSUCCESSFUL.
  358.  
  359. This is a log file that the door appends to, giving you a history of
  360. activity in the door.  If you are running on a multinode system you will
  361. see the node number appended to the end of the prefix.  Since this file
  362. appends, you may wish to delete or archive it periodically.
  363.  
  364.  
  365. FAXDV.DOC --> Created by Jon Anderson, used by permission
  366. ──────────────────────────────────────────────────────────────────────────
  367. Information and complete batch file to open a window in Desqview for a
  368. receive fax option using BitFax 3.0 - take a peek!
  369.  
  370.  
  371. Setting up BitFax
  372. ──────────────────────────────────────────────────────────────────────────
  373. I followed the instructions for BitFax when installing the software and
  374. suggest you do the same.  Make a subdirectory called BITFAX on your drive,
  375. change to the subdirectory, and copy the contents of the BitFax/SR Program
  376. disk into the subdirectory.  You should place the Fax-Door files in this
  377. same directory, as the Fax-Door will read the Log file created by BitFax.
  378. You should set the BITFAX=\BITFAX environment variable in your autoexec.bat
  379. file, and include the BITFAX subdirectory in your PATH= statement.
  380.  
  381. Be sure to set your com port correctly on the fax card.  I run a Hayes
  382. Ultra on Com1 and have the fax card set to use Com3/IRQ 4.  I elected
  383. to have the Modem Speaker OFF at all times... it is rather loud!
  384.  
  385. Once your card is installed and your software is loaded onto the hard
  386. drive you should type BITFAX and set up the BitFax parameters.  Please
  387. follow the BitFax manual.  Their manual contains step by step instructions.
  388.  
  389.  
  390. Registration Cost
  391. ──────────────────────────────────────────────────────────────────────────
  392. The DOOR only costs $10.00!!  It is a full working version and is not
  393. crippled in anyway.
  394.  
  395.  
  396. Support the Shareware concept...
  397. ──────────────────────────────────────────────────────────────────────────
  398. To Register, please print out and return the REGISTER.FRM in the Zip file.
  399. Now, when you register, you will be given a small program which you run in
  400. your door subdirectory.  This program will create a *.REG which will
  401. instantly register your existing copy of the door program, and any and all
  402. future versions as well.  This means that any future releases you find will
  403. automatically continue to say registered to you, without the need to come
  404. back to me.  I hope you'll appreciate this new system.  You should be able
  405. to call The Phantom BBS and make your initial call, wait until I receive
  406. your payment, and download this small utility without spending alot of time
  407. on the phone.  Or, for an additional $5.00 per order, I can send you the
  408. whole package on disk using the postal service.  The choice is yours.
  409. There is an Update Door which grants access to all Registered Users, and
  410. allows you to download your register utilities for the programs you have
  411. registered.
  412.  
  413.  
  414. Thanks for your support!
  415.  
  416.